Detail Data Masking by ID

This API returns detailed information about a specific masking function identified by ID.

---

Endpoint Details

URL	/v1/masking/functions/id
Method	GET
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Request Path

To retrieve the details of a specific masking function, use the following request format:

/v1/masking/functions/f9cff6f3-362e-4b09-af3b-5b1f4ce90051

---

Path Parameter

Parameter	Type	Description
id	UUID	Unique identifier of the masking function

---

Response

Here is an example of a response when viewing data details:

Response

{
    "function": {
        "id": "f9cff6f3-362e-4b09-af3b-5b1f4ce90051",
        "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
        "name": "Dumy",
        "masking_character": "#",
        "masking_type": 2,
        "partial_masking_option": 1,
        "group_id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
        "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "created_at": "2026-07-13T13:54:55+07:00",
        "updated_at": "2026-07-13T13:54:55+07:00",
        "assigned_user_ids": [
            "0a937c60-0ed4-4d06-870a-2e284b54287d"
        ]
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the masking function
tenant_id	UUID	Identifier of the tenant that owns the masking function
name	String	Name of the masking function
masking_character	String	Character used to mask the data
masking_type	Integer	Type of masking applied by the function
partial_masking_option	Integer	Position option used for partial masking
group_id	UUID	Identifier of the associated group
created_by	UUID	Identifier of the user who created the function
updated_by	UUID	Identifier of the user who last updated the function
created_at	String	Creation timestamp in RFC 3339 date-time format
updated_at	String	Last update timestamp in RFC 3339 date-time format
assigned_user_ids	Array	List of user IDs assigned to the masking function

---

info

• A valid Bearer Token is required to access this endpoint.
• The id path parameter must reference an existing masking function.
• Supported masking_type values are:
  • 1 = Full Masking
  • 2 = Partial Masking
  • 3 = Random Masking
  • 4 = Custom Masking
• Supported partial_masking_option values (used when masking_type is 2):
  • 1 = Prefix
  • 2 = Suffix